Skip to content

build(deps-dev): bump the mkdocs group with 4 updates#994

Merged
lars-reimann merged 1 commit intomainfrom
dependabot/pip/mkdocs-45c8fa0ba7
Mar 1, 2025
Merged

build(deps-dev): bump the mkdocs group with 4 updates#994
lars-reimann merged 1 commit intomainfrom
dependabot/pip/mkdocs-45c8fa0ba7

Conversation

@dependabot
Copy link
Copy Markdown
Contributor

@dependabot dependabot bot commented on behalf of github Mar 1, 2025

Bumps the mkdocs group with 4 updates: mkdocstrings, mkdocstrings-python, mkdocs-autorefs and mkdocs-material.

Updates mkdocstrings from 0.27.0 to 0.28.1

Release notes

Sourced from mkdocstrings's releases.

0.28.1

0.28.1 - 2025-02-14

Compare with 0.28.0

Bug Fixes

0.28.0

0.28.0 - 2025-02-03

Compare with 0.27.0

Breaking Changes

Although the following changes are "breaking" in terms of public API, we didn't find any public use of these classes and methods on GitHub.

  • mkdocstrings.extension.AutoDocProcessor.__init__(parser): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(md): Positional parameter was moved
  • mkdocstrings.extension.AutoDocProcessor.__init__(config): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(handlers): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.AutoDocProcessor.__init__(autorefs): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.MkdocstringsExtension.__init__(config): Parameter was removed
  • mkdocstrings.extension.MkdocstringsExtension.__init__(handlers): Positional parameter was moved
  • mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs): Positional parameter was moved
  • mkdocstrings.handlers.base.Handlers.__init__(config): Parameter was removed
  • mkdocstrings.handlers.base.Handlers.__init__(theme): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(default): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(inventory_project): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(tool_config): Parameter was added as required

Similarly, the following parameters were renamed, but the methods are only called from our own code, using positional arguments.

  • mkdocstrings.handlers.base.BaseHandler.collect(config): Parameter was renamed options
  • mkdocstrings.handlers.base.BaseHandler.render(config): Parameter was renamed options

Finally, the following method was removed, but this is again taken into account in our own code:

  • mkdocstrings.handlers.base.BaseHandler.get_anchors: Public object was removed

For these reasons, and because we're still in v0, we do not bump to v1 yet. See following deprecations.

Deprecations

mkdocstrings 0.28 will start emitting these deprecations warnings:

The handler argument is deprecated. The handler name must be specified as a class attribute.

Previously, the get_handler function would pass a handler (name) argument to the handler constructor. This name must now be set on the handler's class directly.

... (truncated)

Changelog

Sourced from mkdocstrings's changelog.

0.28.1 - 2025-02-14

Compare with 0.28.0

Bug Fixes

0.28.0 - 2025-02-03

Compare with 0.27.0

Breaking Changes

Although the following changes are "breaking" in terms of public API, we didn't find any public use of these classes and methods on GitHub.

  • mkdocstrings.extension.AutoDocProcessor.__init__(parser): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(md): Positional parameter was moved
  • mkdocstrings.extension.AutoDocProcessor.__init__(config): Parameter was removed
  • mkdocstrings.extension.AutoDocProcessor.__init__(handlers): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.AutoDocProcessor.__init__(autorefs): Parameter kind was changed: positional or keyword -> keyword-only
  • mkdocstrings.extension.MkdocstringsExtension.__init__(config): Parameter was removed
  • mkdocstrings.extension.MkdocstringsExtension.__init__(handlers): Positional parameter was moved
  • mkdocstrings.extension.MkdocstringsExtension.__init__(autorefs): Positional parameter was moved
  • mkdocstrings.handlers.base.Handlers.__init__(config): Parameter was removed
  • mkdocstrings.handlers.base.Handlers.__init__(theme): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(default): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(inventory_project): Parameter was added as required
  • mkdocstrings.handlers.base.Handlers.__init__(tool_config): Parameter was added as required

Similarly, the following parameters were renamed, but the methods are only called from our own code, using positional arguments.

  • mkdocstrings.handlers.base.BaseHandler.collect(config): Parameter was renamed options
  • mkdocstrings.handlers.base.BaseHandler.render(config): Parameter was renamed options

Finally, the following method was removed, but this is again taken into account in our own code:

  • mkdocstrings.handlers.base.BaseHandler.get_anchors: Public object was removed

For these reasons, and because we're still in v0, we do not bump to v1 yet. See following deprecations.

Deprecations

mkdocstrings 0.28 will start emitting these deprecations warnings:

The handler argument is deprecated. The handler name must be specified as a class attribute.

Previously, the get_handler function would pass a handler (name) argument to the handler constructor. This name must now be set on the handler's class directly.

</tr></table>

... (truncated)

Commits
  • 145954c chore: Prepare release 0.28.1
  • 4ab180d fix: Renew MkDocs' relpath processor instead of using same instance
  • ede1941 chore: Increase mkdocstrings-python lower bound again
  • e1eb99c docs: Use inventories instead of import for Python example
  • 926dd7e docs: Remove trailing spaces
  • 698a321 chore: Update mkdocstrings-python dev-dep to force uv to install it
  • 1cb9177 chore: Update location of the Python handler's JSON schema
  • 6ef1412 chore: Prepare release 0.28.0
  • 936275e Merge branch 'main' of github.com:mkdocstrings/mkdocstrings
  • 3cf7d51 fix: Update handlers in JSON schema to be an object instead of an array
  • Additional commits viewable in compare view

Updates mkdocstrings-python from 1.13.0 to 1.16.1

Release notes

Sourced from mkdocstrings-python's releases.

1.16.1

1.16.1 - 2025-02-18

Compare with 1.16.0

Bug Fixes

  • Give precedence to user-provided paths when they are already listed in sys.path (0f497d1 by Timothée Mazzucotelli). Issue-248

1.16.0

1.16.0 - 2025-02-17

Compare with 1.15.1

Features

  • Add option to show/hide overloads (4a5ee10 by Pete Stenger). PR-250

1.15.1

1.15.1 - 2025-02-17

Compare with 1.15.0

Bug Fixes

  • Unwrap Annotated regardless of signature_crossrefs (d809f1a by Timothée Mazzucotelli). Issue-249

1.15.0

1.15.0 - 2025-02-11

Compare with 1.14.6

Features

  • Support cross-referencing constructor parameters in instance attribute values (f07bf58 by Timothée Mazzucotelli).

1.14.6

1.14.6 - 2025-02-07

Compare with 1.14.5

Bug Fixes

  • Catch alias resolution errors when getting aliases for an identifier (0aaa260 by Timothée Mazzucotelli). Issue-358

Code Refactoring

  • Improve translations for Simplified Chinese and Japanese (753a0df by Zhikang Yan). PR-244

1.14.5

... (truncated)

Changelog

Sourced from mkdocstrings-python's changelog.

1.16.1 - 2025-02-18

Compare with 1.16.0

Bug Fixes

  • Give precedence to user-provided paths when they are already listed in sys.path (0f497d1 by Timothée Mazzucotelli). Issue-248

1.16.0 - 2025-02-17

Compare with 1.15.1

Features

  • Add option to show/hide overloads (4a5ee10 by Pete Stenger). PR-250

1.15.1 - 2025-02-17

Compare with 1.15.0

Bug Fixes

  • Unwrap Annotated regardless of signature_crossrefs (d809f1a by Timothée Mazzucotelli). Issue-249

1.15.0 - 2025-02-11

Compare with 1.14.6

Features

  • Support cross-referencing constructor parameters in instance attribute values (f07bf58 by Timothée Mazzucotelli).

1.14.6 - 2025-02-07

Compare with 1.14.5

Bug Fixes

  • Catch alias resolution errors when getting aliases for an identifier (0aaa260 by Timothée Mazzucotelli). Issue-358

Code Refactoring

  • Improve translations for Simplified Chinese and Japanese (753a0df by Zhikang Yan). PR-244

1.14.5 - 2025-02-05

Compare with 1.14.4

Bug Fixes

... (truncated)

Commits
  • 15a7009 chore: Prepare release 1.16.1
  • 0f497d1 fix: Give precedence to user-provided paths when they are already listed in `...
  • e3a303c chore: Prepare release 1.16.0
  • 4a5ee10 feat: Add option to show/hide overloads
  • 20cae2c chore: Prepare release 1.15.1
  • d809f1a fix: Unwrap Annotated regardless of signature_crossrefs
  • b557ff3 docs: Fix canonical path in Griffe extension for our custom config fields
  • ab3b227 chore: Prepare release 1.15.0
  • f07bf58 feat: Support cross-referencing constructor parameters in instance attribute ...
  • 24afd5d docs: Wrap schema input configuration under a python property
  • Additional commits viewable in compare view

Updates mkdocs-autorefs from 1.3.0 to 1.4.0

Release notes

Sourced from mkdocs-autorefs's releases.

1.4.0

1.4.0 - 2025-02-24

Compare with 1.3.1

Features

Code Refactoring

  • Move code to internal folder, expose public API in top-level module, document all public objects (9615d13 by Timothée Mazzucotelli).
  • Store actual page instance instead of URL in plugin's current_page attribute (8023588 and 2009f85 by Timothée Mazzucotelli).
  • Use the on_env hook to fix cross-references (70fec3e by Timothée Mazzucotelli). Discussion-mkdocs-3917
  • Record heading titles alongside URLs (791782e by Timothée Mazzucotelli). Issue-33

1.3.1

1.3.1 - 2025-02-11

Compare with 1.3.0

Bug Fixes

  • Always resolve secondary URLs to closest (don't log warnings) (243ad35 by Timothée Mazzucotelli). Issue-52
Changelog

Sourced from mkdocs-autorefs's changelog.

1.4.0 - 2025-02-24

Compare with 1.3.1

Features

Code Refactoring

  • Move code to internal folder, expose public API in top-level module, document all public objects (9615d13 by Timothée Mazzucotelli).
  • Store actual page instance instead of URL in plugin's current_page attribute (8023588 and 2009f85 by Timothée Mazzucotelli).
  • Use the on_env hook to fix cross-references (70fec3e by Timothée Mazzucotelli). Discussion-mkdocs-3917
  • Record heading titles alongside URLs (791782e by Timothée Mazzucotelli). Issue-33

1.3.1 - 2025-02-11

Compare with 1.3.0

Bug Fixes

  • Always resolve secondary URLs to closest (don't log warnings) (243ad35 by Timothée Mazzucotelli). Issue-52
Commits
  • 901d382 chore: Prepare release 1.4.0
  • b21aefd fix: Only preserve tags in titles if Material for MkDocs' content.tooltips ...
  • b653e01 chore: Reorganize code within modules
  • 3b769b7 docs: Simplify API docs
  • b04c64d chore: Template upgrade
  • 2009f85 fix: Patch MkDocs pages to provide an __str__ method returning their URL
  • 9615d13 refactor: Move code to internal folder, expose public API in top-level module...
  • 101651c chore: Template upgrade
  • 5a3b387 feat: Add backlinks feature
  • 8023588 refactor: Store actual page instance instead of URL in plugin's `current_page...
  • Additional commits viewable in compare view

Updates mkdocs-material from 9.6.2 to 9.6.5

Release notes

Sourced from mkdocs-material's releases.

mkdocs-material-9.6.5

  • Fixed #8016: Tags listing not showing when when file name has spaces
  • Fixed #8012: Privacy plugin crashes if HTTP download fails

mkdocs-material-9.6.4

  • Fixed #7985: Blog content sometimes not stretching to full width
  • Fixed #7978: Navigation rendering bug in Safari 18.3

mkdocs-material-9.6.3

  • Fixed rendering of arrow heads in Mermaid.js class diagrams
  • Fixed #7960: Tags plugin crashes on numeric metadata titles
Changelog

Sourced from mkdocs-material's changelog.

mkdocs-material-9.6.5 (2025-02-20)

  • Fixed #8016: Tags listing not showing when when file name has spaces
  • Fixed #8012: Privacy plugin crashes if HTTP download fails

mkdocs-material-9.6.4 (2025-02-12)

  • Fixed #7985: Blog content sometimes not stretching to full width
  • Fixed #7978: Navigation rendering bug in Safari 18.3

mkdocs-material-9.6.3 (2025-02-07)

  • Fixed rendering of arrow heads in Mermaid.js class diagrams
  • Fixed #7960: Tags plugin crashes on numeric metadata titles

mkdocs-material-9.6.2 (2025-02-03)

  • Fixed #7955: Excessively long words don't break on narrow screens
  • Fixed #7947: Scope setting interferes with outdated version banner

mkdocs-material-9.6.1 (2025-01-31)

  • Fixed #7943: Tags plugin crashing due to merge error

mkdocs-material-9.6.0 (2025-01-31)

  • Added meta plugin
  • Rewrite of the tags plugin
  • Added support for allow lists in tags plugin
  • Added support for and custom sorting in tags plugin
  • Added support for related links in blog plugin
  • Added support for custom index pages in blog plugin
  • Added support for navigation subtitles
  • Fixed #7924: Anchors might require two clicks when using instant navigation

mkdocs-material-9.5.50 (2025-01-18)

  • Fixed #7913: Social plugin renders attribute lists in page title

mkdocs-material-9.5.49+insiders-4.53.15 (2025-01-15)

  • Fixed #7896: Scoped tags listings not rendering in subsections

mkdocs-material-9.5.49 (2024-12-16)

  • Adjusted title color in dark mode for all supported Mermaid.js diagrams
  • Fixed #7803: Privacy plugin crashes on generated files
  • Fixed #7781: Mermaid.js flow chart title not visible in dark mode

mkdocs-material-9.5.48 (2024-12-08)

... (truncated)

Commits

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
  • @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
  • @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
  • @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
  • @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

@dependabot
build(deps-dev): bump the mkdocs group with 4 updates
a627818 
Bumps the mkdocs group with 4 updates: [mkdocstrings](https://github.com/mkdocstrings/mkdocstrings), [mkdocstrings-python](https://github.com/mkdocstrings/python), [mkdocs-autorefs](https://github.com/mkdocstrings/autorefs) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocstrings` from 0.27.0 to 0.28.1
- [Release notes](https://github.com/mkdocstrings/mkdocstrings/releases)
- [Changelog](https://github.com/mkdocstrings/mkdocstrings/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/mkdocstrings@0.27.0...0.28.1)

Updates `mkdocstrings-python` from 1.13.0 to 1.16.1
- [Release notes](https://github.com/mkdocstrings/python/releases)
- [Changelog](https://github.com/mkdocstrings/python/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/python@1.13.0...1.16.1)

Updates `mkdocs-autorefs` from 1.3.0 to 1.4.0
- [Release notes](https://github.com/mkdocstrings/autorefs/releases)
- [Changelog](https://github.com/mkdocstrings/autorefs/blob/main/CHANGELOG.md)
- [Commits](mkdocstrings/autorefs@1.3.0...1.4.0)

Updates `mkdocs-material` from 9.6.2 to 9.6.5
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.6.2...9.6.5)

---
updated-dependencies:
- dependency-name: mkdocstrings
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: mkdocs
- dependency-name: mkdocstrings-python
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: mkdocs
- dependency-name: mkdocs-autorefs
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: mkdocs
- dependency-name: mkdocs-material
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: mkdocs
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot requested a review from lars-reimann as a code owner March 1, 2025 05:33
@dependabot dependabot bot added dependencies Pull requests that update a dependency file python Pull requests that update Python code labels Mar 1, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 1, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.40%. Comparing base (9bc5673) to head (a627818).
Report is 21 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #994   +/-   ##
=======================================
  Coverage   95.40%   95.40%           
=======================================
  Files         135      135           
  Lines        8213     8213           
=======================================
  Hits         7836     7836           
  Misses        377      377

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@lars-reimann lars-reimann merged commit 30902fb into main Mar 1, 2025
10 checks passed
@lars-reimann lars-reimann deleted the dependabot/pip/mkdocs-45c8fa0ba7 branch March 1, 2025 19:26
@lars-reimann
Copy link
Copy Markdown
Member

lars-reimann commented May 3, 2025

🎉 This PR is included in version 0.30.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label May 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lars-reimann lars-reimann Awaiting requested review from lars-reimann

Assignees

No one assigned

Labels

dependencies Pull requests that update a dependency file python Pull requests that update Python code released Included in a release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@lars-reimann